Skip to main content

Installation

ProvenAI consists of a set of microservices that can be deployed on your own infrastructure. The installation process is straightforward and can be done in a few steps.

Prerequisites​

Before you start the installation process, make sure you have the following prerequisites:

  • Docker
  • Docker Compose
  • OS Linux, MacOS or Windows with WSL
  • 16GB Ram

Installation​

The installation process is simple and can be done in a few steps. It requires just running docker compose with some extra steps to generate access keys for the services to interact with each other.

Step 1: Clone the repository​

git clone https://github.com/ctrl-space-labs/proven-ai.git

Step 2: Set up environment variables​

In ./proven-ai/provenai-compose-scripts/local-installation/.env-local, and set up the environment variables according to Environment Variables documentation.

note

The .env-local file contains some environment variables are comented out. These are mandatory variables that the user must create for the provenAI app to operate correctly. More information on the mandatory variables created by the developer here.

AWS Keys for S3 integration are mandatory.

Step 3: Build and run docker compose​

cd ./proven-ai/provenai-compose-scripts/local-installation
docker-compose --env-file .env-local pull
docker-compose --env-file .env-local up -d

This command pulls all the containers for the necessary services in the provenAI ecosystem:

  • provenAI backend
  • provenAI frontend
  • provenAI SDK
  • gendox backend
  • gendox frontend
  • database container
  • keycloak container

Local Development​

To run the applications independently for development purposes, you need to install:

  • Java 21
  • Maven
  • Node.js
  • NPM or Yarn

Also you need to clone the provenAI repository:

git clone https://github.com/ctrl-space-labs/proven-ai.git

Running the ProvenAI Backend​

ProvenAI backend is a Spring boot application. Once the environment variables are set up (see here).

Step 1: Build and run provenAI SDK docker compose.​

To run the backend you also need to run the provenAI SDK docker-compose. To set up the provenAI docker:

cd ./provenai-sdk/provenai-sdk-docker-compose
docker-compose build
docker-compose up

Step 2: Run the provenAI Backend.​

After the docker-compose is set up you can run the provenAI backend:

cd ./provenai-backend
mvn clean install
mvn spring-boot:run

Running the ProvenAI Frontend​

ProvenAI frontend is a React/Next.js application. No Next.js Server-Side-Rendering features are used. Once the environment variables are set up (see here), you can run the frontend using the following command:

cd ./proven-ai/provenai-frontend
npm install
yarn dev